[tools][cmake] fix type handling when generating CMake targets #11149

xym-ee · 2026-01-23T02:24:48Z

拉取/合并请求描述：(PR description)

为什么提交这份PR (why to submit this PR)

在 ubuntu 使用 scons --target=cmake 生成 CMake 工程时，当前 CMake 生成器在处理 CPPDEFINES 会抛出异常。

试了几个 bsp，基本上都有这个问题

stm32f407-atk-explorer
stm32h743-armfly-v7
imxrt1064-nxp-evk
gd32450z-eval
qemu-vexpress-a9

报错信息一致

m@vm22:~/rt-thread/bsp/stm32/stm32f407-atk-explorer$ scons --target=cmake
scons: Reading SConscript files ...
Newlib version: 4.1.0
Update setting files for CMakeLists.txt...
Cannot find the param of the c standard in build flag, set to default 11
Cannot find the param of the cpp standard in build flag, set to default 17
TypeError: can only concatenate str (not "tuple") to str:
  File "/home/m/rt-thread/bsp/stm32/stm32f407-atk-explorer/SConstruct", line 75:
    DoBuilding(TARGET, objs)
  File "/home/m/rt-thread/tools/building.py", line 803:
    EndBuilding(target, program)
  File "/home/m/rt-thread/tools/building.py", line 916:
    GenTargetProject(program)
  File "/home/m/rt-thread/tools/building.py", line 880:
    CMakeProject(Env, Projects, GetOption('project-name'))
  File "/home/m/rt-thread/tools/targets/cmake.py", line 343:
    GenerateCFiles(env, project, project_name)
  File "/home/m/rt-thread/tools/targets/cmake.py", line 190:
    cm_file.write("\t-D" + i + "\n")

你的解决方案是什么 (what is your solution)

CMake 生成脚本在拼接宏定义时，遇到了一个「tuple（元组）」类型的宏，而不是字符串，导致 Python 报错。

cm_file.write("\t-D" + i + "\n")

增加调试输出查看 i 的类型和值

for i in env['CPPDEFINES']:
    print("[CMAKE][CPPDEFINE] type:", type(i), "value:", i)
    cm_file.write("\t-D" + i + "\n")

得到输出

[CMAKE][CPPDEFINE] type: <class 'tuple'> value: ('STM32F407xx',)

当前 CMake 生成器在处理 CPPDEFINES 时默认假设宏定义为字符串类型，并直接进行字符串拼接生成 -D 参数。

当遇到 SCons 规范化后的 tuple 形式宏定义（例如 ('STM32F407xx',)）时，由于未进行类型判断，导致在字符串拼接阶段触发 TypeError，从而中断 CMake 工程的生成流程。

需要说明的是，该问题并非 BSP 或用户宏定义写法错误，而是 CMake 生成器对 CPPDEFINES 的类型假设过于严格。

本 PR 对 CMake 生成器中 CPPDEFINES 的处理逻辑进行了完善，使其能够正确兼容 SCons 中合法的宏定义表示形式：

对单元素 tuple（如 ("FOO",)）按无值宏处理，生成 -DFOO
对 (name, None) 形式的宏同样生成 -Dname
对 (name, value) 形式的宏生成 -Dname=value

保持原有字符串形式宏定义的处理方式不变

该修改使 CMake 工程生成行为与 SCons 的宏定义语义保持一致，提高了工具链的健壮性和兼容性。

影响范围

不影响现有 SCons 构建流程
不需要修改 BSP 或组件中的宏定义写法
仅增强 CMake 生成器对合法 CPPDEFINES 形式的支持

请提供验证的bsp和config (provide the config and bsp)

在这两个 bsp 中验证，

stm32f407-atk-explorer
qemu-vexpress-a9

执行 scons --target=cmake 后，不再报异常，可以成功使用 cmake 构建工具。

当前拉取/合并请求的状态 Intent for your PR

必须选择一项 Choose one (Mandatory):

本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality：

我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:

已经仔细查看过代码改动的对比 Already check the difference between PR and old code
代码风格正确，包括缩进空格，命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
没有垃圾代码，代码尽量精简，不包含#if 0代码，不包含已经被注释了的代码 All redundant code is removed and cleaned up
所有变更均有原因及合理的，并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
代码是高质量的 Code in this PR is of high quality
已经使用formatting 等源码格式化工具确保格式符合RT-Thread代码规范 This PR complies with RT-Thread code specification
如果是新增bsp, 已经添加ci检查到.github/ALL_BSP_COMPILE.json 详细请参考链接BSP自查

github-actions · 2026-01-23T02:24:57Z

👋 感谢您对 RT-Thread 的贡献！Thank you for your contribution to RT-Thread!

为确保代码符合 RT-Thread 的编码规范，请在你的仓库中执行以下步骤运行代码格式化工作流（如果格式化CI运行失败）。
To ensure your code complies with RT-Thread's coding style, please run the code formatting workflow by following the steps below (If the formatting of CI fails to run).

🛠 操作步骤 | Steps

前往 Actions 页面 | Go to the Actions page
点击进入工作流 → | Click to open workflow →
点击 Run workflow | Click Run workflow

设置需排除的文件/目录（目录请以"/"结尾）
Set files/directories to exclude (directories should end with "/")
将目标分支设置为 \ Set the target branch to：cmake-tools-fix
设置PR number为 \ Set the PR number to：11149

等待工作流完成 | Wait for the workflow to complete
格式化后的代码将自动推送至你的分支。
The formatted code will be automatically pushed to your branch.

完成后，提交将自动更新至 cmake-tools-fix 分支，关联的 Pull Request 也会同步更新。
Once completed, commits will be pushed to the cmake-tools-fix branch automatically, and the related Pull Request will be updated.

如有问题欢迎联系我们，再次感谢您的贡献！💐
If you have any questions, feel free to reach out. Thanks again for your contribution!

xym-ee · 2026-01-23T07:15:47Z

测试了一下可能是 scons 版本的问题，4.0.1 / 4.1.0 / 4.2.0 / 4.3.0 / 4.4.0 都会报这个错误。4.5.0 / 4.5.2 ，windows env 自带的 4.10.0 的都没这个问题。猜测 4.5.0 版本之后的在生成 cmake 项目时都不存在这个问题。

4.0.1

4.4.0

4.5.2

Copilot

Pull request overview

This PR fixes a TypeError that occurs when generating CMake projects from SCons build files using scons --target=cmake. The issue affected multiple BSPs (stm32f407-atk-explorer, stm32h743-armfly-v7, imxrt1064-nxp-evk, gd32450z-eval, qemu-vexpress-a9) because the CMake generator assumed all CPPDEFINES were strings, but SCons can produce tuple-based macro definitions like ('STM32F407xx',).

Changes:

Enhanced CPPDEFINES processing in CMake generator to handle both string and tuple types from SCons
Added type checking to support single-element tuples (e.g., ('FOO',)), two-element tuples with values (e.g., ('FOO', 1)), and two-element tuples with None (e.g., ('FOO', None))
Maintained backward compatibility with existing string-based macro definitions

tools/targets/cmake.py

[tools][cmake] fix type handling when generating CMake targets [Root Cause] Unexpected macro definition types during `scons --target=cmake` could trigger a TypeError and abort CMakeLists.txt generation. [Solution] Add support for handling different macro definition types. [Affect Area] cmake.py [Test Suggestion] Run `scons --target=cmake` and verify CMakeLists.txt is generated successfully with different macro definition formats.

github-actions bot added the tools label Jan 23, 2026

Rbb666 requested a review from Copilot January 25, 2026 04:06

Copilot started reviewing on behalf of Rbb666 January 25, 2026 04:07 View session

Copilot AI reviewed Jan 25, 2026

View reviewed changes

tools/targets/cmake.py Outdated Show resolved Hide resolved

tools/targets/cmake.py Show resolved Hide resolved

tools/targets/cmake.py Outdated Show resolved Hide resolved

xym-ee force-pushed the cmake-tools-fix branch from bd82300 to dc8065d Compare January 25, 2026 05:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[tools][cmake] fix type handling when generating CMake targets #11149

[tools][cmake] fix type handling when generating CMake targets #11149

xym-ee commented Jan 23, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Jan 23, 2026

Uh oh!

xym-ee commented Jan 23, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

[tools][cmake] fix type handling when generating CMake targets #11149

Are you sure you want to change the base?

[tools][cmake] fix type handling when generating CMake targets #11149

Conversation

xym-ee commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

拉取/合并请求描述：(PR description)

为什么提交这份PR (why to submit this PR)

你的解决方案是什么 (what is your solution)

请提供验证的bsp和config (provide the config and bsp)

当前拉取/合并请求的状态 Intent for your PR

代码质量 Code Quality：

Uh oh!

github-actions bot commented Jan 23, 2026

🛠 操作步骤 | Steps

Uh oh!

xym-ee commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

4.0.1

4.4.0

4.5.2

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

xym-ee commented Jan 23, 2026 •

edited

Loading

xym-ee commented Jan 23, 2026 •

edited

Loading